<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeStreamMem: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="GMimeStreamGIO.html" title="GMimeStreamGIO">
<link rel="next" href="GMimeStreamMmap.html" title="GMimeStreamMmap">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GMimeStreamMem.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeStreamMem.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeStreamGIO.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GMimeStreamMmap.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeStreamMem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeStreamMem.top_of_page"></a>GMimeStreamMem</span></h2>
<p>GMimeStreamMem — A memory-backed stream</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeStreamMem.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new" title="g_mime_stream_mem_new ()">g_mime_stream_mem_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new-with-byte-array" title="g_mime_stream_mem_new_with_byte_array ()">g_mime_stream_mem_new_with_byte_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new-with-buffer" title="g_mime_stream_mem_new_with_buffer ()">g_mime_stream_mem_new_with_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GByteArray</span> *
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-get-byte-array" title="g_mime_stream_mem_get_byte_array ()">g_mime_stream_mem_get_byte_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-byte-array" title="g_mime_stream_mem_set_byte_array ()">g_mime_stream_mem_set_byte_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-get-owner" title="g_mime_stream_mem_get_owner ()">g_mime_stream_mem_get_owner</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-owner" title="g_mime_stream_mem_set_owner ()">g_mime_stream_mem_set_owner</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeStreamMem.html#GMimeStreamMem-struct" title="struct GMimeStreamMem">GMimeStreamMem</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a>
        <span class="lineart">╰──</span> GMimeStreamMem
</pre>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.description"></a><h2>Description</h2>
<p>A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that uses a memory buffer for
storage.</p>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-stream-mem-new"></a><h3>g_mime_stream_mem_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_mem_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-new.returns"></a><h4>Returns</h4>
<p> a new memory stream.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-new-with-byte-array"></a><h3>g_mime_stream_mem_new_with_byte_array ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_mem_new_with_byte_array (<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> with data <em class="parameter"><code>array</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-new-with-byte-array.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>array</p></td>
<td class="parameter_description"><p>source data</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-mem-new-with-byte-array.returns"></a><h4>Returns</h4>
<p> a new memory stream using <em class="parameter"><code>array</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-new-with-buffer"></a><h3>g_mime_stream_mem_new_with_buffer ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_stream_mem_new_with_buffer (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                   <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object and initializes the stream
contents with the first <em class="parameter"><code>len</code></em>
 bytes of <em class="parameter"><code>buffer</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-new-with-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>stream data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=len][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>buffer length</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-mem-new-with-buffer.returns"></a><h4>Returns</h4>
<p> a new memory stream initialized with <em class="parameter"><code>buffer</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-get-byte-array"></a><h3>g_mime_stream_mem_get_byte_array ()</h3>
<pre class="programlisting"><span class="returnvalue">GByteArray</span> *
g_mime_stream_mem_get_byte_array (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);</pre>
<p>Gets the byte array from the memory stream.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-get-byte-array.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-mem-get-byte-array.returns"></a><h4>Returns</h4>
<p>the byte array from the memory stream. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-set-byte-array"></a><h3>g_mime_stream_mem_set_byte_array ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_stream_mem_set_byte_array (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>,
                                  <em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre>
<p>Sets the byte array on the memory stream.</p>
<p>Note: The memory stream is not responsible for freeing the byte
array. Use <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-owner" title="g_mime_stream_mem_set_owner ()"><code class="function">g_mime_stream_mem_set_owner()</code></a> to change this behavior.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-set-byte-array.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>array</p></td>
<td class="parameter_description"><p>stream data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-get-owner"></a><h3>g_mime_stream_mem_get_owner ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_stream_mem_get_owner (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);</pre>
<p>Gets whether or not <em class="parameter"><code>mem</code></em>
 owns the backend memory buffer.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-get-owner.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-stream-mem-get-owner.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>mem</code></em>
owns the backend memory buffer or <code class="literal">FALSE</code>
otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-stream-mem-set-owner"></a><h3>g_mime_stream_mem_set_owner ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_stream_mem_set_owner (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>,
                             <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre>
<p>Sets whether or not <em class="parameter"><code>mem</code></em>
 owns the backend memory buffer.</p>
<p>Note: <em class="parameter"><code>owner</code></em>
 should be <code class="literal">TRUE</code> if the stream should free the backend
memory buffer when destroyed or <code class="literal">FALSE</code> otherwise.</p>
<div class="refsect3">
<a name="g-mime-stream-mem-set-owner.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mem</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>owner</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if this stream should own the <span class="type">GByteArray</span> or <code class="literal">FALSE</code> otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeStreamMem-struct"></a><h3>struct GMimeStreamMem</h3>
<pre class="programlisting">struct GMimeStreamMem;</pre>
<p>A memory-backed <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>.</p>
<div class="refsect3">
<a name="GMimeStreamMem.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeStreamMem.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>